Configuration Services
Holds/Permissions
Holds/Permissions view
The Holds/Permissions view displays the holds and permissions that exist at the current scope level. You use a hold/permission to define a service business rule (on page 1) to set up a condition that prevents an event from occurring for the target entity.
When choosing between a hold and a permission type, the most important consideration is whether preventing the associated event from happening is a common occurrence or an exception. If it is a common occurrence, we recommend you use Permissions types to prevent an event from occurring for all target entities of a specific type.
For example, if you define a Customs Export Permission for all export containers leaving the country, it will ensure that no container leaves the terminal until the required permission is granted.
A Hold type, on the other hand, can be used for more specific situations that are not applicable to a large set of target entities.
For example, in some countries, the Customs Department randomly selects import containers arriving on a vessel to require being X-Rayed before they can be delivered. The X-Ray hold will have to be applied to the specified units while the other units will remain unaffected.
To use a hold or permission, you must define a corresponding service business rule. For more information, see Service Business Rules view (on page 1).
When a corresponding service business rule is defined, a Permission type by default:
Is automatically applied to all target entities that satisfy the filter criteria defined in the service business rule and,
Is required and prevents an event from occurring.
Must be granted for the target entity to allow the event to occur.
If granted, must be canceled for a target entity to prevent the event from occurring.
For example, a container may require a customs permission before it can be delivered.
When a corresponding service business rule is defined, a Hold type by default:
Must be manually added to a target entity to prevent the event from occurring
Must be released for a target entity to allow the event to occur.
If released, must be manually added again to a target entity to prevent the event from occurring.
For example, you must add a customs inspection hold to a container to prevent the container from being delivered before it is inspected.
For an existing Simple Hold or Simple Permission service business rule, you can configure an auto update rule to automatically add/release a hold or grant/cancel a permission when an event occurs. You should also consider that instead of using a Permission type, you can configure an auto update rule to automatically add a Hold type to a large set of target entities when an event occurs. For more information, see Auto Update Rule form (on page 1).
You can add holds/permissions, and edit or delete existing holds/permissions from this view.
You cannot delete a hold/permission if it is used in an active service business rule.
In addition, you can use the Actions menu to:
Recover Obsolete (on page 1): Recover deleted holds/permissions.
Purge (on page 1): Purge holds/permissions.
Short Label |
Long Label |
In Filter? |
Sorting? |
---|---|---|---|
Applies To |
Applies To |
X |
X |
Apply Event |
Apply Event |
X |
X |
Billing Hold |
Billing Hold Required |
X |
X |
Changed |
Changed |
X |
X |
Changer |
Changer |
X |
X |
Created |
Created |
X |
X |
Creator |
Creator |
X |
X |
Description |
Description |
X |
X |
Hold/Perm Groups |
Hold/Permission Groups |
X |
X |
ID |
Id |
X |
X |
LifeCycleState |
Life Cycle State |
X |
X |
MultipleHolds Allowed |
MultipleHolds Allowed |
X |
X |
Ref ID Required |
Reference ID Required |
X |
X |
Type |
Type |
X |
X |
Unique by RefId |
Unique by Reference ID |
X |
X |
Veto Event |
Veto Event |
X |
X |